<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FreeRTOS Addons: RWLockPreferWriter_t_ Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">FreeRTOS Addons
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.5 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="struct_r_w_lock_prefer_writer__t__-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">RWLockPreferWriter_t_ Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a7c460cc1d63e3a4d1be49a83b3b30a89"><td class="memItemLeft" align="right" valign="top">SemaphoreHandle_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_w_lock_prefer_writer__t__.html#a7c460cc1d63e3a4d1be49a83b3b30a89">BlockReadersLock</a></td></tr>
<tr class="separator:a7c460cc1d63e3a4d1be49a83b3b30a89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a03c4ecf646f24afd714ecbccc40ba11a"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_w_lock_prefer_writer__t__.html#a03c4ecf646f24afd714ecbccc40ba11a">ReadCount</a></td></tr>
<tr class="separator:a03c4ecf646f24afd714ecbccc40ba11a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7adb0e6593b1c0d3aacf43061e35e3a8"><td class="memItemLeft" align="right" valign="top">SemaphoreHandle_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_w_lock_prefer_writer__t__.html#a7adb0e6593b1c0d3aacf43061e35e3a8">ReadLock</a></td></tr>
<tr class="separator:a7adb0e6593b1c0d3aacf43061e35e3a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a127b535f1202520e6cd30646dd552782"><td class="memItemLeft" align="right" valign="top">SemaphoreHandle_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_w_lock_prefer_writer__t__.html#a127b535f1202520e6cd30646dd552782">ResourceLock</a></td></tr>
<tr class="separator:a127b535f1202520e6cd30646dd552782"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19e41c79985ddd8b58dc1007ce993e51"><td class="memItemLeft" align="right" valign="top"><a id="a19e41c79985ddd8b58dc1007ce993e51" name="a19e41c79985ddd8b58dc1007ce993e51"></a>
enum ReaderWriterLockType&#160;</td><td class="memItemRight" valign="bottom"><b>Type</b></td></tr>
<tr class="separator:a19e41c79985ddd8b58dc1007ce993e51"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cf6fca21a61859bf94bead07c091b6b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_w_lock_prefer_writer__t__.html#a0cf6fca21a61859bf94bead07c091b6b">WriteCount</a></td></tr>
<tr class="separator:a0cf6fca21a61859bf94bead07c091b6b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac8b17e5894fded347367b0be339ed1fe"><td class="memItemLeft" align="right" valign="top">SemaphoreHandle_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_r_w_lock_prefer_writer__t__.html#ac8b17e5894fded347367b0be339ed1fe">WriteLock</a></td></tr>
<tr class="separator:ac8b17e5894fded347367b0be339ed1fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a7c460cc1d63e3a4d1be49a83b3b30a89" name="a7c460cc1d63e3a4d1be49a83b3b30a89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c460cc1d63e3a4d1be49a83b3b30a89">&#9670;&#160;</a></span>BlockReadersLock</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SemaphoreHandle_t RWLockPreferWriter_t_::BlockReadersLock</td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Lock to stop reader threads from starving a Writer. </p>

</div>
</div>
<a id="a03c4ecf646f24afd714ecbccc40ba11a" name="a03c4ecf646f24afd714ecbccc40ba11a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03c4ecf646f24afd714ecbccc40ba11a">&#9670;&#160;</a></span>ReadCount</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int RWLockPreferWriter_t_::ReadCount</td>
        </tr>
      </table>
</div><div class="memdoc">
<p >How many active readers are there. </p>

</div>
</div>
<a id="a7adb0e6593b1c0d3aacf43061e35e3a8" name="a7adb0e6593b1c0d3aacf43061e35e3a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7adb0e6593b1c0d3aacf43061e35e3a8">&#9670;&#160;</a></span>ReadLock</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SemaphoreHandle_t RWLockPreferWriter_t_::ReadLock</td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Protect ReadCount. </p>

</div>
</div>
<a id="a127b535f1202520e6cd30646dd552782" name="a127b535f1202520e6cd30646dd552782"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a127b535f1202520e6cd30646dd552782">&#9670;&#160;</a></span>ResourceLock</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SemaphoreHandle_t RWLockPreferWriter_t_::ResourceLock</td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Protect this resource from multiple writer access, or from Reader access when a writer is changing something. </p>

</div>
</div>
<a id="a0cf6fca21a61859bf94bead07c091b6b" name="a0cf6fca21a61859bf94bead07c091b6b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cf6fca21a61859bf94bead07c091b6b">&#9670;&#160;</a></span>WriteCount</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int RWLockPreferWriter_t_::WriteCount</td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Number of Writers waiting for the Resource Lock, including any current Writer already holdign it. </p>

</div>
</div>
<a id="ac8b17e5894fded347367b0be339ed1fe" name="ac8b17e5894fded347367b0be339ed1fe"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac8b17e5894fded347367b0be339ed1fe">&#9670;&#160;</a></span>WriteLock</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SemaphoreHandle_t RWLockPreferWriter_t_::WriteLock</td>
        </tr>
      </table>
</div><div class="memdoc">
<p >Protect WriteCount. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/freertos-addon/c/read_write_lock.c</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
</small></address>
</body>
</html>
